Empty Bucket
AutomatR.AWS.Activities.EmptyBucket
The "Empty Bucket" activity in AutomatR is part of the AWS S3 (Simple Storage Service) activities package, enabling automation processes to remove all content from a specified Amazon S3 bucket. This activity streamlines the process of emptying a bucket, enhancing the efficiency of automation workflows.
Properties
| Name | Description |
|---|---|
| Input | |
| Access Key ID | Provides the encrypted access key ID for your AWS account, enabling connection to the AWS S3 service. String variables containing the access key ID. |
| Secret Access Key | Provides the encrypted secret access key for your AWS account, enabling connection to the AWS S3 service. String variables containing the secret access key. |
| Region | Specifies the Amazon S3 region associated with the bucket intended to be emptied. Use the RegionEndpoint enumeration to set the region. |
| Bucket Name | Specifies the name of the Amazon S3 bucket from which all content will be removed. String variables containing the bucket name. |
| Misc | |
| Display Name | Provides a customizable name for the activity displayed in the workflow. The display name enhances clarity and organization within the automation project. String variable or argument containing the desired display name. |
| Optional | |
| Delay | Specifies the amount of time (in seconds) to wait before executing the "Empty Bucket" activity. Useful for handling synchronization issues. Integer variables containing the delay duration. Ex.: If the wait time is 1000 milliseconds or 1 sec, i.e., 1. |
| Output | |
| Result | Outputs the result of the "Empty Bucket" operation, indicating whether the bucket was successfully emptied or encountered errors. Variables of relevant types (e.g., Boolean variables) to store the operation result. |
How to use:
- Drag and drop the "Empty Bucket" activity onto the workflow.
- Configure the properties by providing the required inputs, such as access key ID, secret access key, Amazon S3 region, and the name of the bucket to be emptied.
- Optionally, configure the delay and customize the display name.
- Execute the workflow to remove all content from the specified Amazon S3 bucket.
Example: Consider an example where the "Empty Bucket" activity is used to remove all content from an S3 bucket named "MyDataBucket":
Empty Bucket:
Display Name: "Empty S3 Bucket"
Access Key ID: "**************"
Secret Access Key: "**************"
Region: "us-west-2"
Bucket Name: "MyDataBucket"
Result: isBucketEmptied
In this example, the activity removes all content from the "MyDataBucket" S3 bucket. The result of the operation (success or failure) is stored in the Boolean variable "isBucketEmptied" for further handling in the workflow.